<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BonoboStreamMem</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Libbonobo Reference Manual">
<link rel="up" href="streams.html" title="Storages and Streams">
<link rel="prev" href="libbonobo-bonobo-storage-memory.html" title="bonobo-storage-memory">
<link rel="next" href="libbonobo-bonobo-storage.html" title="bonobo-storage">
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libbonobo-bonobo-storage-memory.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="streams.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Libbonobo Reference Manual</th>
<td><a accesskey="n" href="libbonobo-bonobo-storage.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libbonobo-bonobo-stream-memory.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libbonobo-bonobo-stream-memory.description" class="shortcut">Description</a>
                   | 
                  <a href="#libbonobo-bonobo-stream-memory.object-hierarchy" class="shortcut">Object Hierarchy</a>
</td></tr>
</table>
<div class="refentry">
<a name="libbonobo-bonobo-stream-memory"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libbonobo-bonobo-stream-memory.top_of_page"></a>BonoboStreamMem</span></h2>
<p>BonoboStreamMem — In-memory implementation of Bonobo::Stream interface.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libbonobo-bonobo-stream-memory.synopsis"></a><h2>Synopsis</h2>
<a name="BonoboStreamMem"></a><pre class="synopsis">                    <a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem-struct" title="BonoboStreamMem">BonoboStreamMem</a>;
                    <a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMemClass" title="BonoboStreamMemClass">BonoboStreamMemClass</a>;
<a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="returnvalue">BonoboStreamMem</span></a> *   <a class="link" href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-construct" title="bonobo_stream_mem_construct ()">bonobo_stream_mem_construct</a>         (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="type">BonoboStreamMem</span></a> *stream_mem</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>,
                                                         <em class="parameter"><code><span class="type">size_t</span> size</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> resizable</code></em>);
<a class="link" href="libbonobo-bonobo-object.html#BonoboObject"><span class="returnvalue">BonoboObject</span></a> *      <a class="link" href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-create" title="bonobo_stream_mem_create ()">bonobo_stream_mem_create</a>            (<em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>,
                                                         <em class="parameter"><code><span class="type">size_t</span> size</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> resizable</code></em>);
const <span class="returnvalue">char</span> *        <a class="link" href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-get-buffer" title="bonobo_stream_mem_get_buffer ()">bonobo_stream_mem_get_buffer</a>        (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="type">BonoboStreamMem</span></a> *stream_mem</code></em>);
<span class="returnvalue">size_t</span>              <a class="link" href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-get-size" title="bonobo_stream_mem_get_size ()">bonobo_stream_mem_get_size</a>          (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="type">BonoboStreamMem</span></a> *stream_mem</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-stream-memory.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a class="link" href="libbonobo-bonobo-object.html#BonoboObject">BonoboObject</a>
         +----BonoboStreamMem
</pre>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-stream-memory.description"></a><h2>Description</h2>
<p>
   The BonoboStreamMem is an implementation of the
   IDL:Bonobo/Stream:1.0 interface.  This implementation allows an
   in-memory buffer to be exposed as a IDL:Bonobo/Stream:1.0 to
   clients.
</p>
<p>
   Here is a sample way of exposing a C string as an
   IDL:Bonobo/Stream:1.0:
   </p>
<div class="example">
<a name="id3173075"></a><p class="title"><b>Example 22. Sample BonoboStreamMem usage</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4</pre></td>
        <td class="listing_code"><pre class="programlisting"><span class="usertype">BonoboStream</span><span class="normal"> </span><span class="symbol">*</span><span class="function">make_bonobo_stream_on_string</span><span class="normal"> </span><span class="symbol">(</span><span class="type">char</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">string</span><span class="symbol">)</span>
<span class="cbracket">{</span>
<span class="normal">    </span><span class="keyword">return</span><span class="normal"> </span><span class="function"><a href="libbonobo-bonobo-stream-memory.html#bonobo-stream-mem-create">bonobo_stream_mem_create</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">string</span><span class="symbol">,</span><span class="normal"> </span><span class="function">strlen</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">string</span><span class="symbol">),</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS">TRUE</a></span><span class="symbol">,</span><span class="normal"> <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS">FALSE</a></span><span class="symbol">);</span>
<span class="cbracket">}</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<p><br class="example-break">
   This example will make the string argument be exposed as a CORBA
   stream.  </p>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-stream-memory.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="BonoboStreamMem-struct"></a><h3>BonoboStreamMem</h3>
<pre class="programlisting">typedef struct _BonoboStreamMem BonoboStreamMem;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="BonoboStreamMemClass"></a><h3>BonoboStreamMemClass</h3>
<pre class="programlisting">typedef struct {
	BonoboObjectClass parent_class;

	POA_Bonobo_Stream__epv epv;

	char           *(*get_buffer) (BonoboStreamMem *stream_mem);
	size_t          (*get_size)   (BonoboStreamMem *stream_mem);
} BonoboStreamMemClass;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-stream-mem-construct"></a><h3>bonobo_stream_mem_construct ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="returnvalue">BonoboStreamMem</span></a> *   bonobo_stream_mem_construct         (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="type">BonoboStreamMem</span></a> *stream_mem</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>,
                                                         <em class="parameter"><code><span class="type">size_t</span> size</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> resizable</code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream_mem</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>read_only</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>resizable</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-stream-mem-create"></a><h3>bonobo_stream_mem_create ()</h3>
<pre class="programlisting"><a class="link" href="libbonobo-bonobo-object.html#BonoboObject"><span class="returnvalue">BonoboObject</span></a> *      bonobo_stream_mem_create            (<em class="parameter"><code>const <span class="type">char</span> *buffer</code></em>,
                                                         <em class="parameter"><code><span class="type">size_t</span> size</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> read_only</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> resizable</code></em>);</pre>
<p>
Creates a new BonoboStreamMem object.
</p>
<p>
If <em class="parameter"><code>buffer</code></em> is non-<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, <em class="parameter"><code>size</code></em> bytes are copied from it into a new
buffer. If <em class="parameter"><code>buffer</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, a new buffer of size <em class="parameter"><code>size</code></em> is created
and filled with zero bytes.
</p>
<p>
When data is read out of or (if <em class="parameter"><code>read_only</code></em> is FALSE) written into
the returned BonoboStream object, the <code class="function">read()</code> and <code class="function">write()</code> operations
operate on the new buffer. If <em class="parameter"><code>resizable</code></em> is TRUE, writing or seeking
past the end of the buffer will cause the buffer to be expanded (with
the new space zero-filled for a seek).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
<td>The data for which a BonoboStreamMem object is to be created.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
<td>The size in bytes of <em class="parameter"><code>buffer</code></em>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>read_only</code></em> :</span></p></td>
<td>Specifies whether or not the returned BonoboStreamMem
object should allow <code class="function">write()</code> operations.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>resizable</code></em> :</span></p></td>
<td>Whether or not the buffer should be resized as needed.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the constructed BonoboStream object
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-stream-mem-get-buffer"></a><h3>bonobo_stream_mem_get_buffer ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *        bonobo_stream_mem_get_buffer        (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="type">BonoboStreamMem</span></a> *stream_mem</code></em>);</pre>
<p>
Returns the buffer associated with a BonoboStreamMem. If the stream
is set to automatically resize itself, this buffer is only guaranteed
to stay valid until the next write operation on the stream.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream_mem</code></em> :</span></p></td>
<td>a BonoboStreamMem
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a buffer containing the data written to the stream (or
the data the stream was initialized with if nothing has been written).
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="bonobo-stream-mem-get-size"></a><h3>bonobo_stream_mem_get_size ()</h3>
<pre class="programlisting"><span class="returnvalue">size_t</span>              bonobo_stream_mem_get_size          (<em class="parameter"><code><a class="link" href="libbonobo-bonobo-stream-memory.html#BonoboStreamMem"><span class="type">BonoboStreamMem</span></a> *stream_mem</code></em>);</pre>
<p>
Returns the size of the data associated with a BonoboStreamMem
see bonobo_stream_mem_get_buffer
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream_mem</code></em> :</span></p></td>
<td>a BonoboStreamMem
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the size.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="libbonobo-bonobo-stream-memory.see-also"></a><h2>See Also</h2>
<p>
  </p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><span class="type">BonoboStream</span></span></p></td>
<td><p>An abstract class to implement
      IDL:Bonobo/Streams.</p></td>
</tr>
<tr>
<td><p><span class="term">IDL:Bonobo/Stream:1.0</span></p></td>
<td><p>The CORBA interface implemented .</p></td>
</tr>
</tbody>
</table></div>
<p>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15.1</div>
</body>
</html>